\hypertarget{class_parameter_map}{
\section{ParameterMap Class Reference}
\label{class_parameter_map}\index{ParameterMap@{ParameterMap}}
}
{\tt \#include $<$Parameter.h$>$}

\subsection*{Classes}
\begin{CompactItemize}
\item 
struct \hyperlink{struct_parameter_map_1_1_file_not_created}{FileNotCreated}
\begin{CompactList}\small\item\em Exception types when the file can't be created. \item\end{CompactList}\item 
struct \hyperlink{struct_parameter_map_1_1_key_not_found}{KeyNotFound}
\begin{CompactList}\small\item\em Exception types when a key is not found. \item\end{CompactList}\end{CompactItemize}
\subsection*{Public Types}
\begin{CompactItemize}
\item 
typedef \hyperlink{class_down_converter}{DownConverter}$<$ \hyperlink{class_parameter___a_b_c}{Parameter\_\-ABC}, \hyperlink{class_parameter}{Parameter} $>$ \hyperlink{class_parameter_map_38a7269bf37190387b52d7a9edc1ac35}{converter}
\item 
\hypertarget{class_parameter_map_1fff90798a02ad663ce4154602ccf9e1}{
typedef map$<$ string, \hyperlink{class_down_converter}{converter} $>$::iterator \hyperlink{class_parameter_map_1fff90798a02ad663ce4154602ccf9e1}{mapi}}
\label{class_parameter_map_1fff90798a02ad663ce4154602ccf9e1}

\begin{CompactList}\small\item\em Redefinition of iterators types to faciliate navigation in \_\-contentMap. \item\end{CompactList}\item 
\hypertarget{class_parameter_map_d961f11945662080dd51662fc7fa6e83}{
typedef map$<$ string, \hyperlink{class_down_converter}{converter} $>$::const\_\-iterator \textbf{mapci}}
\label{class_parameter_map_d961f11945662080dd51662fc7fa6e83}

\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
\hyperlink{class_down_converter}{converter} \hyperlink{class_parameter_map_b60b81fcdaece29115fa8c13fc8138dd}{operator\mbox{[}$\,$\mbox{]}} (const string \&key)
\item 
\hypertarget{class_parameter_map_a45305a27f82b7cee4fb67b8ad634ec4}{
mapci \textbf{find} (const string \&str) const }
\label{class_parameter_map_a45305a27f82b7cee4fb67b8ad634ec4}

\item 
\hypertarget{class_parameter_map_b25f3804655b8720d20f3197783f1eb7}{
\hyperlink{class_parameter_map_1fff90798a02ad663ce4154602ccf9e1}{mapi} \textbf{find} (const string \&str)}
\label{class_parameter_map_b25f3804655b8720d20f3197783f1eb7}

\item 
\hypertarget{class_parameter_map_b8213b7faea7f29c7423e9c18ffba007}{
mapci \hyperlink{class_parameter_map_b8213b7faea7f29c7423e9c18ffba007}{begin} () const }
\label{class_parameter_map_b8213b7faea7f29c7423e9c18ffba007}

\begin{CompactList}\small\item\em Return iterators to the beginning and the end of \_\-contentMap. \item\end{CompactList}\item 
\hypertarget{class_parameter_map_175edbd8b0418602153a47dc059bdd41}{
mapci \textbf{end} () const }
\label{class_parameter_map_175edbd8b0418602153a47dc059bdd41}

\item 
void \hyperlink{class_parameter_map_27f7387eae417302792415802ba59caf}{add} (string \&label, \hyperlink{class_down_converter}{converter} ptr)
\item 
\hypertarget{class_parameter_map_3a137c502e74bcc5a4022acadf80a423}{
void \textbf{remove} (string \&label)}
\label{class_parameter_map_3a137c502e74bcc5a4022acadf80a423}

\item 
\hypertarget{class_parameter_map_49ad9a6aa5c67eb6af5b6b15369c5939}{
void \hyperlink{class_parameter_map_49ad9a6aa5c67eb6af5b6b15369c5939}{saveToFile} (const string \&filename)}
\label{class_parameter_map_49ad9a6aa5c67eb6af5b6b15369c5939}

\begin{CompactList}\small\item\em Update the configuration file with the content of the map. \item\end{CompactList}\item 
\hypertarget{class_parameter_map_64ae329db1a6de3e42552053746f2936}{
void \textbf{init} (\hyperlink{class_config_file_parser}{ConfigFileParser} \&\_\-cfg)}
\label{class_parameter_map_64ae329db1a6de3e42552053746f2936}

\end{CompactItemize}
\subsection*{Friends}
\begin{CompactItemize}
\item 
\hypertarget{class_parameter_map_efb5820886dbbe47fd25151ea977f56b}{
void \textbf{printParameterMap} (std::ostream \&os, const \hyperlink{class_parameter_map}{ParameterMap} \&f, string \_\-prefix=\char`\"{}\char`\"{})}
\label{class_parameter_map_efb5820886dbbe47fd25151ea977f56b}

\end{CompactItemize}


\subsection{Detailed Description}
\hyperlink{class_parameter_map}{ParameterMap} is the registry for all \hyperlink{class_parameter}{Parameter} Objects this is coded as a Wrapper object containing a static map. Since the internal map is static, all \hyperlink{class_parameter_map}{ParameterMap} instances refer to the same one. i.e. it is guaranteed that only one map exists, but several \hyperlink{class_parameter_map}{ParameterMap} objects can be instanciated locally in the code to access it 

\subsection{Member Typedef Documentation}
\hypertarget{class_parameter_map_38a7269bf37190387b52d7a9edc1ac35}{
\index{ParameterMap@{ParameterMap}!converter@{converter}}
\index{converter@{converter}!ParameterMap@{ParameterMap}}
\subsubsection[{converter}]{\setlength{\rightskip}{0pt plus 5cm}typedef {\bf DownConverter}$<${\bf Parameter\_\-ABC}, {\bf Parameter}$>$ {\bf ParameterMap::converter}}}
\label{class_parameter_map_38a7269bf37190387b52d7a9edc1ac35}


The type of the objects in the static \_\-contentMap 

\subsection{Member Function Documentation}
\hypertarget{class_parameter_map_27f7387eae417302792415802ba59caf}{
\index{ParameterMap@{ParameterMap}!add@{add}}
\index{add@{add}!ParameterMap@{ParameterMap}}
\subsubsection[{add}]{\setlength{\rightskip}{0pt plus 5cm}void ParameterMap::add (string \& {\em label}, \/  {\bf converter} {\em ptr})\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}
\label{class_parameter_map_27f7387eae417302792415802ba59caf}




register in static \_\-contentMap \hypertarget{class_parameter_map_b60b81fcdaece29115fa8c13fc8138dd}{
\index{ParameterMap@{ParameterMap}!operator\mbox{[}\mbox{]}@{operator[]}}
\index{operator\mbox{[}\mbox{]}@{operator[]}!ParameterMap@{ParameterMap}}
\subsubsection[{operator[]}]{\setlength{\rightskip}{0pt plus 5cm}{\bf ParameterMap::converter} ParameterMap::operator\mbox{[}$\,$\mbox{]} (const string \& {\em key})}}
\label{class_parameter_map_b60b81fcdaece29115fa8c13fc8138dd}


Faciliate access to a value associated to a key. Throw \hyperlink{struct_parameter_map_1_1_key_not_found}{KeyNotFound} when the key doesn't exist. \begin{Desc}
\item[Note:]Difference to map$<$string,string$>$operator\mbox{[}$\,$\mbox{]} is the behaviour on \hyperlink{struct_parameter_map_1_1_key_not_found}{KeyNotFound} \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em key}]the name of the key \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]the value associated (may be I shall return an empty string if the key does not exist). \end{Desc}


The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
/Users/carloshergar/optica/Plasmas/rana-pic/trunk/include/\hyperlink{_parameter_8h}{Parameter.h}\item 
/Users/carloshergar/optica/Plasmas/rana-pic/trunk/src/\hyperlink{_parameter_8cpp}{Parameter.cpp}\end{CompactItemize}
